Skip to content

Script overte - #71

Merged
JulianGro merged 35 commits into
overte-org:masterfrom
zedwick:script_overte
May 8, 2026
Merged

JulianGro merged 35 commits into
overte-org:masterfrom
zedwick:script_overte

Conversation

@zedwick

@zedwick zedwick commented Feb 22, 2026 •

Copy link
Copy Markdown
Contributor

This PR brings the Script section of the docs up to date.

  • Some files have been converted from markdown to reStructuredText to standardise the docs, however usually only when I felt it necessary or simpler for the changes I intended to make.
  • Removed recommendations to use incomplete or non-working functionality.
  • Corrected instructions where the interface had changed, including images where appropriate.
  • Example JavaScript code has been updated to use Strict mode.
  • Changed examples to accommodate and entertain both VR and Desktop users.
  • Rewrote text to remove negative framing in certain places
  • Corrected inaccuracies about the current features of Overte
  • Tested all example code to ensure they work, and fixed them if they did not.
  • Improved clarity in some areas
  • Other miscellaneous changes

* De-emphasise Overte being just a VR platform
* Don't use var in example scripts
* Convert from markdown to reStructuredText format
* Fix syntax error in example code
* Expand Equip Item section with full working example
* Add "use strict" and remove vars in example code
* console.log in an exported function will not show in logs
* "use strict", etc.
* Also add a way for desktop users to try out the avatar script by pressing "x" on their keyboard.
* Remove section on using Package Model to add scripts; does not work
* Replace image of text editor with code block, including highlighted line
* Encourage use of server entity script in some situations
* Correct steps to add a client entity script, with scripts page icon.
* Example script now wil "use strict", etc.
* Correct steps to attach a Server Entity Script to an Entity
* Example script will now "use strict", etc.
* I don't mean to alarm anyone, but it is now closer to 40 years since the 80s. A slight change to the wording to make this tutorial timeless.
* Loading a script from the UI will load it persistently
* clickDownOnEntity only responds to mouse click events; cannot be used in VR with controllers
* mousePressOnEntity responds to both mouse click and controller trigger events
@zedwick
zedwick marked this pull request as ready for review February 24, 2026 12:58
Comment thread source/script/avatar-scripts.rst Resolved
Comment thread source/script/avatar-scripts.rst Resolved
Comment thread source/script/avatar-scripts.rst Resolved
Comment thread source/script/server-entity-scripts.rst Resolved
Comment thread source/script/server-entity-scripts.rst Resolved
Comment thread source/script/server-entity-scripts.rst Resolved
Comment thread source/script/server-entity-scripts.rst Resolved
Comment thread source/script/write-scripts.md Resolved
@JulianGro

Copy link
Copy Markdown
Member

You can apply multiple suggestions at once from the Files changed page.

zedwick and others added 4 commits March 17, 2026 15:44
@zedwick
zedwick requested a review from JulianGro April 20, 2026 13:20

@JulianGro JulianGro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code blocks still have unintended whitespaces. There is also still a bunch of small suggestions to apply.

GitHub is really buggy for me right now when it comes to code review. Many comments aren't shown on the "Files changed" page and some suggestions aren't rendered correctly. Just a heads up about that.

Comment thread source/script/avatar-scripts.rst Resolved
Comment thread source/script/interface-scripts.rst Resolved
@zedwick
zedwick requested a review from JulianGro May 5, 2026 16:18
@zedwick

zedwick commented May 5, 2026

Copy link
Copy Markdown
Contributor Author

I can't even respond to your latest comments directly at the moment, but I've addressed everything I can see.

Co-authored-by: Julian Groß  <julian.g@posteo.de>

@JulianGro JulianGro left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I took the liberty of applying some of my previous suggestions. I assume you missed them because of the GitHub review mess.

@zedwick

zedwick commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

Looks good, thanks Julian.

@JulianGro
JulianGro merged commit bf9b7f1 into overte-org:master May 8, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants